<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OrbbecSDK: ob::Recorder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="orbbec_icon.png"/></td>
  <td id="projectalign">
   <div id="projectname">OrbbecSDK<span id="projectnumber">&#160;1.10.5</span>
   </div>
   <div id="projectbrief">OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceob.html">ob</a></li><li class="navelem"><a class="el" href="classob_1_1Recorder.html">Recorder</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classob_1_1Recorder-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ob::Recorder Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="RecordPlayback_8hpp_source.html">RecordPlayback.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a441e0cde1c82080e273e3041b2772715"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Recorder.html#a441e0cde1c82080e273e3041b2772715">Recorder</a> ()</td></tr>
<tr class="memdesc:a441e0cde1c82080e273e3041b2772715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a recorder for data recording.  <br /></td></tr>
<tr class="separator:a441e0cde1c82080e273e3041b2772715"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf5d5e3c9fd714e0c66bde7d4f0e068e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Recorder.html#abf5d5e3c9fd714e0c66bde7d4f0e068e">Recorder</a> (std::unique_ptr&lt; RecorderImpl &gt; impl)</td></tr>
<tr class="separator:abf5d5e3c9fd714e0c66bde7d4f0e068e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd66ed40058948c71a9cee852f357a17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Recorder.html#acd66ed40058948c71a9cee852f357a17">Recorder</a> (std::shared_ptr&lt; <a class="el" href="classob_1_1Device.html">Device</a> &gt; device)</td></tr>
<tr class="memdesc:acd66ed40058948c71a9cee852f357a17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a recorder for data recording.  <br /></td></tr>
<tr class="separator:acd66ed40058948c71a9cee852f357a17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a89db910d8778a3c1f9e0a598b60430"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Recorder.html#a9a89db910d8778a3c1f9e0a598b60430">~Recorder</a> () noexcept</td></tr>
<tr class="separator:a9a89db910d8778a3c1f9e0a598b60430"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5a0b732fbdc4ec156b5a610e7c50165"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Recorder.html#aa5a0b732fbdc4ec156b5a610e7c50165">start</a> (const char *filename, bool async=false)</td></tr>
<tr class="memdesc:aa5a0b732fbdc4ec156b5a610e7c50165"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the recorder. Throws an exception on failure.  <br /></td></tr>
<tr class="separator:aa5a0b732fbdc4ec156b5a610e7c50165"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4fe634ead9a37d0a87f2b7e7d252f98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Recorder.html#ac4fe634ead9a37d0a87f2b7e7d252f98">stop</a> ()</td></tr>
<tr class="memdesc:ac4fe634ead9a37d0a87f2b7e7d252f98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the recorder. Throws an exception on failure.  <br /></td></tr>
<tr class="separator:ac4fe634ead9a37d0a87f2b7e7d252f98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae703692af04cec5c36155d87cd68ea06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Recorder.html#ae703692af04cec5c36155d87cd68ea06">write</a> (std::shared_ptr&lt; <a class="el" href="classob_1_1Frame.html">Frame</a> &gt; frame)</td></tr>
<tr class="memdesc:ae703692af04cec5c36155d87cd68ea06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write frame data to the recorder.  <br /></td></tr>
<tr class="separator:ae703692af04cec5c36155d87cd68ea06"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="RecordPlayback_8hpp_source.html#l00023">23</a> of file <a class="el" href="RecordPlayback_8hpp_source.html">RecordPlayback.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a441e0cde1c82080e273e3041b2772715" name="a441e0cde1c82080e273e3041b2772715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a441e0cde1c82080e273e3041b2772715">&#9670;&#160;</a></span>Recorder() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ob::Recorder::Recorder </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a recorder for data recording. </p>

</div>
</div>
<a id="abf5d5e3c9fd714e0c66bde7d4f0e068e" name="abf5d5e3c9fd714e0c66bde7d4f0e068e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf5d5e3c9fd714e0c66bde7d4f0e068e">&#9670;&#160;</a></span>Recorder() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ob::Recorder::Recorder </td>
          <td>(</td>
          <td class="paramtype">std::unique_ptr&lt; RecorderImpl &gt;&#160;</td>
          <td class="paramname"><em>impl</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="acd66ed40058948c71a9cee852f357a17" name="acd66ed40058948c71a9cee852f357a17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd66ed40058948c71a9cee852f357a17">&#9670;&#160;</a></span>Recorder() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ob::Recorder::Recorder </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classob_1_1Device.html">Device</a> &gt;&#160;</td>
          <td class="paramname"><em>device</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a recorder for data recording. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">device</td><td>The device for which to record device information. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a9a89db910d8778a3c1f9e0a598b60430" name="a9a89db910d8778a3c1f9e0a598b60430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a89db910d8778a3c1f9e0a598b60430">&#9670;&#160;</a></span>~Recorder()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ob::Recorder::~Recorder </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa5a0b732fbdc4ec156b5a610e7c50165" name="aa5a0b732fbdc4ec156b5a610e7c50165"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5a0b732fbdc4ec156b5a610e7c50165">&#9670;&#160;</a></span>start()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Recorder::start </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>async</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable the recorder. Throws an exception on failure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>The name of the recorded file. </td></tr>
    <tr><td class="paramname">async</td><td>Whether to execute asynchronously. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ac4fe634ead9a37d0a87f2b7e7d252f98" name="ac4fe634ead9a37d0a87f2b7e7d252f98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4fe634ead9a37d0a87f2b7e7d252f98">&#9670;&#160;</a></span>stop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Recorder::stop </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stop the recorder. Throws an exception on failure. </p>

</div>
</div>
<a id="ae703692af04cec5c36155d87cd68ea06" name="ae703692af04cec5c36155d87cd68ea06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae703692af04cec5c36155d87cd68ea06">&#9670;&#160;</a></span>write()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ob::Recorder::write </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classob_1_1Frame.html">Frame</a> &gt;&#160;</td>
          <td class="paramname"><em>frame</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Write frame data to the recorder. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">frame</td><td>The frame data to write. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/<a class="el" href="RecordPlayback_8hpp_source.html">RecordPlayback.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat May 11 2024 17:13:38 for OrbbecSDK by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
